Skip to content

Docs: answer-first READMEs, FAQ, docs index, llms.txt, trimmed npm page; factual fixes - #69

Open
Karanvir1729 wants to merge 6 commits into
mainfrom
docs/seo-aeo-npm
Open

Karanvir1729 wants to merge 6 commits into
mainfrom
docs/seo-aeo-npm

Conversation

@Karanvir1729

Copy link
Copy Markdown
Collaborator

What

Implements the docs, scrapability, SEO/AEO and npm landing page audit. Answer-first READMEs with one canonical definition; FAQ.md; docs/runtime/README.md index and glossary; llms.txt, CITATION.cff; the npm README trimmed under 60,000 characters (npm truncates at 65,536) with reference material moved to docs/runtime/INSTALL.md, DASHBOARD.md, SINKS.md; package.json description and keywords; about 30 factual corrections (e.g. late-revert window 800 ms, the compat matrix commit, gate guidance for the 0.2.0 gain gate, FIR wording).

Notes for the reviewer

  • Not finished: the last check found one open issue in README.md ("How GenClass compares": the sinks sentence says reports reach your own logging from 0.3.0; it contradicts SINKS.md and needs correcting).
  • Needs the owner: THREAT-MODEL.md T10 to T12 and the pinning advice (security review); the training-data wording (situation-v2 plus v2.3 top-ups); CITATION.cff author; PRIVACY.md vs "your own classifier" (the policy says app data is never used to train); NOTICE in the tarball; the forwarding wording in src/cdn/sinks.ts, bin/lib/init.mjs and telemetry-worker/src/forward.ts.
  • The npm page only changes when 0.3.0 is published as latest; @genclass/runtime-model's page needs a docs-only republish. genclass.dev pages need a site rebuild.
  • No src/, test/, AGENTS.md, CONTRACT.md or NOTICE change. Earlier rounds ran the runtime, worker and Playwright tests and npm pack; the final test run's result was not read before opening this PR.

🤖 Generated with Claude Code

Karanvir1729 and others added 2 commits October 22, 2026 14:19
…pm page; factual fixes

Implements a six-surface audit (README, npm pages, docs, accuracy, AEO). Every number checked against
RESULTS.md, compat/RESULTS.md, the model card or the code; FIR next to recall. The package README is
under 60,000 characters (npm truncates at 65,536), with reference material moved to docs/runtime/
INSTALL.md, DASHBOARD.md and SINKS.md. New: FAQ.md, docs/runtime/README.md (index and glossary),
llms.txt, CITATION.cff, issue template config. No src/, test/, AGENTS.md, CONTRACT.md or NOTICE change.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…mcp) into docs/seo-aeo-npm

Conflicts resolved by hand: both package.json files take main's version (0.3.0-beta.1) with this branch's
descriptions; the trimmed READMEs keep their structure and gain main's "Your coding agent" section, the
packages/mcp row and the 0.3.0-beta.1 script-tag pin; THREAT-MODEL.md keeps T10 to T12 and adds the bridge as
T13 (residual 14); RESULTS.md keeps sections 16 and 17 and adds the coding-agent measurement as section 18, with a
row in the summary table. References in CHANGELOG.md, AGENT.md and the root README follow the new numbers;
docs/runtime/README.md and llms.txt list AGENT.md.

tsc clean, tsup builds, vitest 1,101 passed (14 model-parity skips), review-perf 4 of 4.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Karanvir1729 and others added 4 commits October 24, 2026 21:13
# Conflicts:
#	README.md
#	packages/playwright/README.md
#	packages/playwright/package.json
# Conflicts:
#	docs/runtime/RESULTS.md
#	packages/runtime/README.md
…talled, analytics visits) into docs/seo-aeo-npm

Eleven files conflicted; each keeps this branch's answer-first structure and carries main's newer facts: the runtime
package.json takes 0.3.0-beta.4 with this branch's description; both READMEs state today's dist-tags, pin
@0.3.0-beta.4 in script tags, and gain the scan/audit command, summary().requests, the three new measured checks,
the analytics navigation paths and visit flag, and @genclass/mcp 0.2.0; the root README has its "**Status:" line
back, which packages/sv/test/edit.test.ts reads (the check that failed on the pull request); TELEMETRY.md, PRIVACY.md,
ANALYTICS.md and OPTIONS-SPEC.md take main's new sections on visits, funnels, devices and the new options;
INTERCEPTION.md's machine-checked inventory equals main's. RESULTS.md's two sections appended on main after this
branch's §16 and §17 are now §23 and §24, and AGENTS.md, VISUAL.md, bench/visual/README.md, the runtime README and
CHANGELOG follow.

tsc clean, tsup builds, runtime vitest 1,212 passed (14 model-parity skips); @genclass/sv unit 24 passed;
@genclass/mcp 132 passed.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…raise advisory) into docs/seo-aeo-npm

Three files conflicted. THREAT-MODEL.md T8 takes main's text: raising the mode from a link needs a development host
(src/devhost.ts) and `debug: true` is console logging only. INTERCEPTION.md takes main's sessionStorage row (the
sampling bucket is reused only under the same `sample`) and keeps this branch's localStorage row. The runtime README
keeps its trimmed script-tag paragraph and adds main's `data-devtools="local"` host list. Five passages this branch
wrote still described the old behaviour (local or private hosts and `debug: true` raising the mode): the threat
model's residual 8 and recommended setup, the docs index's glossary, the runtime README's URL-override paragraph,
OPTIONS-SPEC's formula comment and batch note, and API.md's effectiveMode sentence now state the current rule.

tsc clean, tsup builds, runtime vitest passed (14 model-parity skips); @genclass/mcp 142 passed; @genclass/sv unit
24 passed.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant